fix: update action type definition #3501
Conversation
nameless-mc
requested review from
chihiro-adachi,
Copilot and
tasshi-me
and removed request for
a team
There was a problem hiding this comment.
Pull Request Overview
This PR improves type safety by expressing the dependency between actions[].type and actions[].executableUser through discriminated unions, ensuring executableUser is required only when type="SECONDARY".
Key Changes:
- Converted
ActionForResponseandActionForParameterto discriminated unions - Made
executableUserrequired fortype="SECONDARY"actions - Removed the unused
ActionTypehelper type
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } & ( | ||
| | { | ||
| type?: "PRIMARY"; | ||
| } | ||
| | { | ||
| type: "SECONDARY"; | ||
| executableUser: { | ||
| entities: ExecutableUserEntityForParameter[]; | ||
| }; | ||
| } | ||
| ); |
There was a problem hiding this comment.
The discriminated union for ActionForParameter has a logical flaw. When type is optional on line 94 (type?: "PRIMARY"), it creates ambiguity: if type is undefined, TypeScript cannot determine which union branch applies. This breaks the discriminated union pattern and could allow objects without type or executableUser to pass type checking. Consider making type required for both branches (remove the ? on line 94) to maintain proper type discrimination, or restructure to explicitly handle the case where type is omitted (e.g., by making it a three-way union with an explicit branch for { type?: undefined }).
Why
The dependency relationship between
actions[].typeandactions[].executableUserwas not expressed inthe type system.
In kintone's process management API,
actions[].executableUseris required in requests and included inresponses only when
actions[].typeis"SECONDARY". By expressing this dependency relationship astype information, we can reduce runtime errors and improve the developer experience.
What
ActionForResponsetype to a discriminated union, adding a type constraint that makesexecutableUserrequired only whentype="SECONDARY"ActionForParametertype to a discriminated union, adding a type constraint that makesexecutableUserrequired only whentype="SECONDARY"ActionTypetypeHow to test
Checklist
pnpm lintandpnpm teston the root directory.